Skip to content

Harden install and upgrade docs - #550

Merged
jeffhuber merged 1 commit into
mainfrom
codex/v09-install-upgrade-docs-542
Sep 2, 2026
Merged

Harden install and upgrade docs#550
jeffhuber merged 1 commit into
mainfrom
codex/v09-install-upgrade-docs-542

Conversation

@jeffhuber

@jeffhuber jeffhuber commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Part of #536. Fixes #542.

Summary

  • add a cold-install vs upgrade section to the install guide
  • document exact pipx upgrades, uv reinstalls, pipx-to-uv migration, and sandboxed pipx directories
  • put the install matrix directly in the 10-minute guide
  • align quickstart Codex smoke/API-key auth guidance with runner docs
  • add troubleshooting for stale command paths and loopback-only Board URLs
  • add release-hygiene coverage for the key install/upgrade snippets

Verification

  • scripts/dev-python -m unittest tests.test_release_hygiene.ReleaseHygieneTests.test_install_and_upgrade_docs_cover_agent_paths tests.test_release_hygiene.ReleaseHygieneTests.test_codex_smoke_docs_use_supported_flags
  • scripts/dev-python -m pytest tests/test_release_hygiene.py
  • scripts/dev-python -m ruff check .
  • scripts/dev-python -m pytest
  • git diff --check
  • scripts/dev-python scripts/privacy_scan.py

Privacy

Docs/tests only. No source, diffs, transcripts, raw stdout/stderr, auth output, local paths, or secrets are uploaded or added by this change.

@jeffhuber jeffhuber added builder:codex Code Mower generated label needs-claude-audit needs-gitar-audit Code Mower generated label labels Sep 2, 2026
@gitar-bot

gitar-bot Bot commented Sep 2, 2026

Copy link
Copy Markdown
Code Review ✅ Approved

Hardens install and upgrade documentation with cold-install vs upgrade guidance, exact package manager procedures (pipx upgrades, uv reinstalls, migration paths), install matrix in the quickstart, aligned authentication examples, troubleshooting for stale paths and loopback Board URLs, and release-hygiene test coverage for install/upgrade snippets. No issues found.

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Auto-apply Compact 
gitar auto-apply:on         

gitar display:verbose

Was this helpful? React with 👍 / 👎 | Gitar

@jeffhuber

jeffhuber commented Sep 2, 2026

Copy link
Copy Markdown
Contributor Author

Claude audit (merge-authority lane)

Head SHA: c3102e0d7fb89a42c9b29528c8985eb3cdada765
Findings: P0=0, P1=0, P2=0, P3=0 (blocker policy: any P0/P1/P2 -> BLOCKED)

Claude Audit: PASS

Summary:

Docs-only PR (README, install/quickstart/troubleshooting/try-in-10-minutes) plus a new self-verifying test that asserts specific strings exist in those docs. Checked every assertion in test_install_and_upgrade_docs_cover_agent_paths against the actual diff content; all match. No code paths changed, no security or data-loss risk introduced. No trusted project context to contradict.

Findings: none.

@jeffhuber jeffhuber added claude-audit-done gitar-audit-done Code Mower generated label and removed needs-claude-audit needs-gitar-audit Code Mower generated label labels Sep 2, 2026
@jeffhuber
jeffhuber merged commit 8780d00 into main Sep 2, 2026
25 checks passed
@jeffhuber
jeffhuber deleted the codex/v09-install-upgrade-docs-542 branch September 2, 2026 21:00
@jeffhuber jeffhuber mentioned this pull request Sep 2, 2026
Closed
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

builder:codex Code Mower generated label claude-audit-done gitar-audit-done Code Mower generated label

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

v0.9: harden install and upgrade docs

1 participant

@jeffhuber